fix: Ensure structured logs from an SDK integration has sentry.origin #4566

alexsohn1126 · 2025-09-25T20:16:32Z

Fixes #4560, fixes #4618

Make sure logs generated from integrations have a sentry.origin attribute attached #4560
Ensure the .NET SDK sets sentry.origin for Structured Logs according to the documentation #4618

Problem

According to our SDK specification, we have to set sentry.origin whenever a log is sent from an integration.

Solution

sentry-dotnet has a few integrations that send out logs. This PR affects the following integrations:

Sentry.Extensions.Logging
Sentry.Serilog

And affects other integrations that references Sentry.Extensions.Logging, or references it transitively.

Comparison

Before, logs from Sentry.Serilog didn't have sentry.origin:

After, logs from Sentry.Serilog has sentry.origin populated:

alexsohn1126 · 2025-09-25T20:29:45Z

@sentry review

alexsohn1126 · 2025-09-25T20:33:08Z

bugbot review

cursor · 2025-09-25T20:33:48Z

🚨 Bugbot couldn't run

Something went wrong. Try again by commenting "Cursor review" or "bugbot run", or contact support (requestId: serverGenReqId_8ec61e90-31f9-40d2-9718-56e6535d466d).

alexsohn1126 · 2025-09-25T20:35:23Z

bugbot review

alexsohn1126 · 2025-09-25T20:39:28Z

@sentry review

codecov · 2025-09-25T20:44:13Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.47%. Comparing base (e58a8f1) to head (84380b4).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4566   +/-   ##
=======================================
  Coverage   73.46%   73.47%           
=======================================
  Files         482      482           
  Lines       17678    17682    +4     
  Branches     3493     3493           
=======================================
+ Hits        12988    12992    +4     
  Misses       3800     3800           
  Partials      890      890

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

CHANGELOG.md

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs

Flash0ver

I'm not 100 % convinced of the origin names that we use right now, but also don't have a concrete suggestion in store ... if you don't mind, I'll let my mind wander a bit and will get back to you soon.
Also, feedback from other reviewers appreciated. @jamescrosswell what do you think?

jamescrosswell · 2025-09-30T22:27:44Z

I'm not 100 % convinced of the origin names that we use right now, but also don't have a concrete suggestion in store ... if you don't mind, I'll let my mind wander a bit and will get back to you soon.
Also, feedback from other reviewers appreciated. @jamescrosswell what do you think?

From memory, we started setting the sentry.origin initially to support tracing... so the naming conventions for these were made with that in mind. It's even titled Trace Origin in the dev docs.

The first/type part of the origin is obvious (either manual or auto).
The second/category part is somewhat subjective (e.g. db or ui) and we try to match whatever the other SDKs are doing here... but some judgement required on our part since the specific databases etc. we're integrating with will often be .NET specific
The third part is the integration name. Ideally this would match the name we used for the integration in our source... so for example in the Sentry.EntityFramework integration we used the origin auto.db.entity_framework. The challenge is that our NuGet packages are optimised to minimise dependencies, so where we can integrate from the Sentry.nupkg without any extra dependencies, we do... which I think is why we ended up with stuff like auto.graphql (in the base Sentry NuGet).
I don't think we use the fourth part / integration-part anywhere in the .NET SDK...

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs

CHANGELOG.md

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs

alexsohn1126 · 2025-10-02T15:43:00Z

Whoops, forgot to mention that we will be consolidating the category for sentry.origin across other Sentry SDKs! Once we have decided on what category, I'll mark this PR as ready..

alexsohn1126 · 2025-10-09T19:46:48Z

The Structured Logs spec was updated. See #4618 for more detail:

Ensure the .NET SDK sets sentry.origin for Structured Logs according to the documentation #4618

Flash0ver

Thanks for aligning the value of "sentry.origin".
One final feedback to fix the CHANGELOG.md.
Then we could release this in 5.16.1.

CHANGELOG.md

Co-authored-by: James Crosswell <[email protected]>

This comment has been minimized.

Sign in to view

This comment was marked as outdated.

Sign in to view

alexsohn1126 changed the title ~~WIP fix: Ensure integration logs have sentry.origin set~~ fix: Ensure integration logs have sentry.origin set Sep 26, 2025

alexsohn1126 marked this pull request as ready for review September 26, 2025 00:01

alexsohn1126 requested review from Flash0ver and jamescrosswell as code owners September 26, 2025 00:01

Flash0ver reviewed Sep 26, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs Outdated Show resolved Hide resolved

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

alexsohn1126 requested a review from Flash0ver September 29, 2025 03:54

Flash0ver reviewed Sep 29, 2025

View reviewed changes

alexsohn1126 changed the title ~~fix: Ensure integration logs have sentry.origin set~~ fix: Ensure structured logs from an SDK integration has sentry.origin Sep 29, 2025

jamescrosswell reviewed Sep 30, 2025

View reviewed changes

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs Outdated Show resolved Hide resolved

jamescrosswell reviewed Sep 30, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

jamescrosswell reviewed Sep 30, 2025

View reviewed changes

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

alexsohn1126 marked this pull request as draft October 1, 2025 14:43

alexsohn1126 changed the title ~~fix: Ensure structured logs from an SDK integration has sentry.origin~~ WIP fix: Ensure structured logs from an SDK integration has sentry.origin Oct 1, 2025

alexsohn1126 marked this pull request as ready for review October 2, 2025 15:37

alexsohn1126 requested a review from Flash0ver October 2, 2025 15:38

alexsohn1126 marked this pull request as draft October 2, 2025 15:41

alexsohn1126 mentioned this pull request Oct 3, 2025

ref(logs): Change documentation for logs sentry.origin consolidation getsentry/sentry-docs#15127

Merged

6 tasks

alexsohn1126 marked this pull request as ready for review October 9, 2025 19:47

alexsohn1126 requested a review from jamescrosswell October 9, 2025 19:51

Flash0ver reviewed Oct 10, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

alexsohn1126 changed the title ~~WIP fix: Ensure structured logs from an SDK integration has sentry.origin~~ fix: Ensure structured logs from an SDK integration has sentry.origin Oct 11, 2025

alexsohn1126 and others added 11 commits October 10, 2025 21:21

Add sentry.origin field to logs for integrations

87f88c7

Add sentry.origin field to logs for Serilog integration as well

96659ce

Add sentry.origin field check to tests

78bfddc

Change sentry.origin to be more descriptive

08a4669

update changelog

f644a66

change sentry.origin category and clarify name

276a583

update changelog

a490059

update sentry.origin for MEL to microsoft_extensions (plural)

f38629a

Update CHANGELOG.md

dcdcf7e

Co-authored-by: James Crosswell <[email protected]>

Update src/Sentry.Extensions.Logging/SentryStructuredLogger.cs

d8a8ad4

Co-authored-by: James Crosswell <[email protected]>

fix tests to reflect name change

6608542

alexsohn1126 force-pushed the alexsohn/fix/sentry-origin-attached-to-sdk-integration-logs branch from 163dff3 to 6608542 Compare October 11, 2025 01:34

Update CHANGELOG.md

84380b4

alexsohn1126 requested a review from Flash0ver October 14, 2025 13:14

Flash0ver approved these changes Oct 14, 2025

View reviewed changes

alexsohn1126 merged commit f33f4d4 into main Oct 14, 2025
33 checks passed

alexsohn1126 deleted the alexsohn/fix/sentry-origin-attached-to-sdk-integration-logs branch October 14, 2025 15:29

This was referenced Oct 15, 2025

Bump Sentry from 5.16.0 to 5.16.1 microting/eform-service-workflow-plugin#1415

Open

Bump Sentry from 5.16.0 to 5.16.1 microting/eform-backendconfiguration-plugin#530

Open

Uh oh!

fix: Ensure structured logs from an SDK integration has sentry.origin #4566

fix: Ensure structured logs from an SDK integration has sentry.origin #4566

Uh oh!

Conversation

alexsohn1126 commented Sep 25, 2025 • edited by Flash0ver Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Comparison

Uh oh!

alexsohn1126 commented Sep 25, 2025

Uh oh!

alexsohn1126 commented Sep 25, 2025

Uh oh!

This comment has been minimized.

cursor bot commented Sep 25, 2025

🚨 Bugbot couldn't run

Uh oh!

alexsohn1126 commented Sep 25, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

alexsohn1126 commented Sep 25, 2025

Uh oh!

codecov bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Flash0ver left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jamescrosswell commented Sep 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

alexsohn1126 commented Oct 2, 2025

Uh oh!

alexsohn1126 commented Oct 9, 2025

Uh oh!

Flash0ver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexsohn1126 commented Sep 25, 2025 •

edited by Flash0ver

Loading

codecov bot commented Sep 25, 2025 •

edited

Loading

Flash0ver left a comment •

edited

Loading